<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sdirxss: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sdirxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__v__sdirxss.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8acb662b4cdd74817ee6b48f166f3e25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sdirxss.html#ga8acb662b4cdd74817ee6b48f166f3e25">XV_SdiRxSs_SubcoreInitSdiRx</a> (<a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *SdiRxSsPtr)</td></tr>
<tr class="memdesc:ga8acb662b4cdd74817ee6b48f166f3e25"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the included sub-core to it's static configuration.  <a href="#ga8acb662b4cdd74817ee6b48f166f3e25">More...</a><br/></td></tr>
<tr class="separator:ga8acb662b4cdd74817ee6b48f166f3e25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fe6048ab8f1692c136fd89d6fdf4e46"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sdirxss.html#ga5fe6048ab8f1692c136fd89d6fdf4e46">XV_SdiRxSs_SelfTest</a> (<a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga5fe6048ab8f1692c136fd89d6fdf4e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs self test on SDI Rx Subsystem sub-cores.  <a href="#ga5fe6048ab8f1692c136fd89d6fdf4e46">More...</a><br/></td></tr>
<tr class="separator:ga5fe6048ab8f1692c136fd89d6fdf4e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b3ce12885916b1fa3043eb74e804d9c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sdirxss.html#ga1b3ce12885916b1fa3043eb74e804d9c">SdiRxSs_SelfTestExample</a> (u32 DeviceId)</td></tr>
<tr class="memdesc:ga1b3ce12885916b1fa3043eb74e804d9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the main entry point for the self test example using the <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> driver.  <a href="#ga1b3ce12885916b1fa3043eb74e804d9c">More...</a><br/></td></tr>
<tr class="separator:ga1b3ce12885916b1fa3043eb74e804d9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__sdirxss.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:gae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the main function for <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> self test example.  <a href="#gae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br/></td></tr>
<tr class="separator:gae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the main function for <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> self test example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the self test example passed.</li>
<li>XST_FAILURE if the self test example was unsuccessful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__v__sdirxss.html#ga1b3ce12885916b1fa3043eb74e804d9c">SdiRxSs_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1b3ce12885916b1fa3043eb74e804d9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 SdiRxSs_SelfTestExample </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the main entry point for the self test example using the <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> driver. </p>
<p>This function check whether or not its sub-core drivers self test functions are in working state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the SDI RX Subsystem core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if any of SDI RX Subsystem sub-core self test failed.</li>
<li>XST_SUCCESS, if all of SDI RX Subsystem sub-core self test passed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_rx_ss___config.html#a532428467186a468acb210613f45d5cf">XV_SdiRxSs_Config::BaseAddress</a>, <a class="el" href="xv__sdirxss_8c.html#a43a9c2aa8bc176afeaa71534eb0e8304">XV_SdiRxSs_CfgInitialize()</a>, <a class="el" href="xv__sdirxss_8h.html#a0e23415bd6bf917e5b2279c2ae6d3cc4">XV_SdiRxSs_LookupConfig()</a>, and <a class="el" href="group__v__sdirxss.html#ga5fe6048ab8f1692c136fd89d6fdf4e46">XV_SdiRxSs_SelfTest()</a>.</p>

<p>Referenced by <a class="el" href="group__v__sdirxss.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5fe6048ab8f1692c136fd89d6fdf4e46"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XV_SdiRxSs_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function performs self test on SDI Rx Subsystem sub-cores. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if self test passed.</li>
<li>XST_FAILURE if self test failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_rx_ss.html#ae3d8d6ae92334dc0e542d1af1f8d9a3e">XV_SdiRxSs::SdiRxPtr</a>.</p>

<p>Referenced by <a class="el" href="group__v__sdirxss.html#ga1b3ce12885916b1fa3043eb74e804d9c">SdiRxSs_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8acb662b4cdd74817ee6b48f166f3e25"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_SdiRxSs_SubcoreInitSdiRx </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *&#160;</td>
          <td class="paramname"><em>SdiRxSsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the included sub-core to it's static configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">SdiRxSsPtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS/XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_rx_ss___sub_core.html#a9f70e8bf6414426919b91556c034c334">XV_SdiRxSs_SubCore::AbsAddr</a>, <a class="el" href="struct_x_v___sdi_rx_ss___config.html#a532428467186a468acb210613f45d5cf">XV_SdiRxSs_Config::BaseAddress</a>, <a class="el" href="struct_x_v___sdi_rx_ss.html#a881d8188fa81829cfb38a44aea36e7a1">XV_SdiRxSs::Config</a>, <a class="el" href="struct_x_v___sdi_rx_ss___sub_core.html#a2e36aeaf865b1e9fe4d437c8b4583781">XV_SdiRxSs_SubCore::DeviceId</a>, <a class="el" href="struct_x_v___sdi_rx_ss___config.html#a778de600283189203c525664695ca373">XV_SdiRxSs_Config::SdiRx</a>, <a class="el" href="struct_x_v___sdi_rx_ss.html#ae3d8d6ae92334dc0e542d1af1f8d9a3e">XV_SdiRxSs::SdiRxPtr</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baab255967dc5490db2cd7f57f778aec61e">XV_SDIRXSS_LOG_EVT_SDIRX_INIT</a>, and <a class="el" href="xv__sdirxss_8h.html#a4ec835467423d601222535543e1ffedf">XV_SdiRxSs_LogWrite()</a>.</p>

<p>Referenced by <a class="el" href="xv__sdirxss_8h.html#a43a9c2aa8bc176afeaa71534eb0e8304">XV_SdiRxSs_CfgInitialize()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
